home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilDisplay.z / ilDisplay
Encoding:
Text File  |  2002-10-03  |  86.9 KB  |  1,914 lines
  1.  
  2.  
  3.  
  4. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllDDDDiiiissssppppllllaaaayyyy - displays multiple images in an X window
  10.  
  11.  
  12. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  13.      This is a base class with no inheritance.
  14.  
  15.  
  16. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  17.      #include <il/ilDisplay.h>
  18.  
  19.  
  20. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  21.      ilDisplay manages the display of multiple ilImages in an X window. An
  22.      ilImage of any size, color model, or orientation can be displayed. In
  23.      addition, any combination of ilImage can be displayed.  OOOOppppeeeennnnGGGGLLLL is used to
  24.      render the images if supported by the visual associated with the X
  25.      window, otherwise X is used. Multiple images are managed as a stack and
  26.      only the exposed area of each image is painted for optimal performance.
  27.  
  28.      AAAAddddddddiiiinnnngggg IIIImmmmaaaaggggeeeessss
  29.  
  30.      Any iiiillllIIIImmmmaaaaggggeeee can be added to the display by using the aaaaddddddddVVVViiiieeeewwww(((()))) member
  31.      function. ilDisplay creates an iiiillllVVVViiiieeeewwww for the image and puts it into a
  32.      view stack. By default, views are put on top of the stack. However, an
  33.      index can be specified or the mode can be used to control where the view
  34.      is inserted in the stack. Views are displayed based on their stacking
  35.      order. Therefore the view on top of the stack is unobscured and other
  36.      views in the stack may be obscured.  Member functions are provided for
  37.      manipulating the view stack such as push, pop, swap and delete.
  38.  
  39.      An iiiillllVVVViiiieeeewwww pointer is returned by aaaaddddddddVVVViiiieeeewwww() and can be used to manipulate
  40.      the view. For example the view can be repositioned and resized. See
  41.      ilView for more information. The pointer to an ilView can be found in
  42.      several ways using the image or index of the view or by specifying an xy
  43.      location.  When finding a view by xy location, a pointer to the topmost
  44.      view at that location is returned. Note that all views in the view stack
  45.      are deleted when ilDisplay is deleted.
  46.  
  47.      DDDDiiiissssppppllllaaaayyyy OOOOppppeeeerrrraaaattttoooorrrrssss
  48.  
  49.      ilDisplay provides several functions or display operators to manipulate
  50.      views within the display window. Display operators are used to do such
  51.      things as move the view within the display, change the size of the view
  52.      or moved the image within the view. These display operators can be
  53.      applied to one or more views in the view stack.  Typical arguments passed
  54.      to a display operator include an _x_y coordinate pair, a pointer to a _v_i_e_w,
  55.      and a _m_o_d_e.
  56.  
  57.      An _i_l_V_i_e_w* is passed to a display operator to specify which view to
  58.      operate on. If NULL is specified, all views in the stack are operated on.
  59.      However, a view is unaffected if its nop (no-operation) flag is set. The
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  71.  
  72.  
  73.  
  74.      function sssseeeettttNNNNoooopppp(((()))) can be used to set the nop flag on a single view or all
  75.      views in the stack.
  76.  
  77.      The _m_o_d_e parameter passed to display operators is comprised of one or
  78.      more bit fields. It is passed as an iiiinnnntttt value to allow the bit fields to
  79.      be combined using a bitwise OR. These bit fields are defined as
  80.      enumerated values in iiiillll////iiiillllDDDDiiiissssppppllllaaaayyyyDDDDeeeeffffssss....hhhh. There are several types of modes
  81.      defined, including: ilDefer to defer painting, ilClip to prevent moving
  82.      beyond the edge of the image, ilNoSwap to prevent swapping back/front
  83.      buffers, and operator-specific flags such as ilRightEdge for the wipe
  84.      operator and coordinate interpretation.
  85.  
  86.      The _x, _y coordinates passed to a display operator can be interpreted as
  87.      absolute values, change from current view configuration, or as relative
  88.      to the values initialized by sssseeeettttMMMMoooouuuusssseeee(((()))).  Coordinate interpretation is
  89.      specified by the following flags in _m_o_d_e:
  91.           _i_l_R_e_l_V_a_l    Interpreted relative to the starting _x_y position
  92.                       established with sssseeeettttMMMMoooouuuusssseeee(). The difference between the
  93.                       specified _x_y parameters and the starting _x_y location is
  94.                       used. The starting _x_y location is then updated. Useful
  95.                       for interactive manipulation.
  96.  
  97.           _i_l_O_l_d_R_e_l    Same as _i_l_R_e_l_V_a_l except that the starting _x,_y location
  98.                       is not updated. This is useful when doing several
  99.                       operations based on the same _x,_y coordinates.
  100.  
  101.           _i_l_D_e_l_V_a_l    Interpreted as changes (delta) to the current view
  102.                       configuration.
  103.  
  104.           _i_l_A_b_s_V_a_l    Interpreted as absolute values relative to the ilDisplay
  105.                       origin (upper-left).
  106.  
  107. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  108.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrr
  109.  
  110.           ilDisplay(Display* display, Window parentWin, int mode = ilDefault)
  111.           ilDisplay(Display* display, int width, int height,
  112.                     int attr=ilVisDoubleBuffer,
  113.                     int minComponentSize=8, int maxComponentSize=0,
  114.                     int mode = ilDefault,
  115.                     long eventMask = ExposureMask|KeyPressMask|
  116.                                      PointerMotionMask|PointerMotionHintMask|
  117.                                      ButtonPressMask|ButtonReleaseMask|
  118.                                      StructureNotifyMask)
  119.  
  120.      SSSSyyyynnnncccchhhhrrrroooonnnniiiizzzzaaaattttiiiioooonnnn aaaannnndddd aaaabbbboooorrrrttttiiiinnnngggg
  121.  
  122.           void syncPaint()
  123.           void flush()
  124.           void abort()
  125.           void enableAutoAbort(int enable=TRUE)
  126.  
  127.  
  128.                                                                         PPPPaaaaggggeeee 2222
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  136.  
  137.  
  138.  
  139.           int isAutoAbortEnabled()
  140.           void enableQueueing(int enable=TRUE)
  141.           int isQueueingEnabled()
  142.  
  143.      XXXX WWWWiiiinnnnddddoooowwww aaaacccccccceeeessssssss aaaannnndddd ccccoooonnnnttttrrrroooollll
  144.  
  145.           void updateWindow()
  146.           void setWindow(Window win, int mode = ilDefault)
  147.           ilXWindowImg* getXWindowImg()
  148.           GLXContext getGLXContext()
  149.           Window getWindow()
  150.           Display* getDisplay()
  151.           Display* getILDisplay()
  152.           void calcWindowSize(int& width, int& height)
  153.           void destroyNotify()
  154.  
  155.      CCCCoooonnnnttttrrrroooolllllllliiiinnnngggg ddddiiiissssppppllllaaaayyyy mmmmooooddddeeeessss
  156.  
  157.           void setMode(int mode = 0)
  158.           void enableFrontRedraw(int enable)
  159.           int isFrontRedrawEnabled()
  160.  
  161.      RRRReeeennnnddddeeeerrrriiiinnnngggg ccccaaaallllllllbbbbaaaacccckkkkssss
  162.  
  163.           void setCallback(ilCallback* prepare, ilCallback* render,
  164.                            ilCallback* finish = NULL)
  165.           void getCallback(ilCallback*& prepare, ilCallback*& render,
  166.                            ilCallback*& finish)
  167.           void enableCallback(int enable = TRUE)
  168.           int isCallbackEnabled()
  169.  
  170.      TTTTiiiilllleeee mmmmaaaappppppppiiiinnnngggg
  171.  
  172.           void mapTile(iflOrientation fromOrientation, iflTile2Dint& tile,
  173.                        iflOrientation toOrientation=iflOrientation(0))
  174.           void mapTile(iflOrientation fromOrientation, iflTile2Dfloat& tile,
  175.                        iflOrientation toOrientation=iflOrientation(0))
  176.           void mapXY(iflOrientation fromOrientation, int& x, int& y,
  177.                      iflOrientation toOrientation=iflOrientation(0))
  178.           void mapXY(iflOrientation fromOrientation, float& x, float& y,
  179.                      iflOrientation toOrientation=iflOrientation(0))
  180.  
  181.      VVVViiiissssiiiibbbblllleeee aaaarrrreeeeaaaa ccccoooonnnnttttrrrroooollll
  182.  
  183.           void setVisibleArea(int x = 0, int y = 0, int nx = 0,
  184.                               int ny = 0)
  185.           void getVisibleArea(int& x, int& y, int& nx, int& ny)
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.                                                                         PPPPaaaaggggeeee 3333
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  202.  
  203.  
  204.  
  205.      AAAAttttttttrrrriiiibbbbuuuutttteeee ggggeeeetttt aaaannnndddd sssseeeetttt
  206.  
  207.           void getPos(int& x, int& y)
  208.           void getSize(int& x, int& y)
  209.           int isRgb()
  210.           int isDoubleBuffer()
  211.           int isDefer(ilView* view = NULL)
  212.           void setDefer(int def, ilView* view = NULL)
  213.           int isStereo()
  214.           int getMargin()
  215.           void setMargin(int margin)
  216.           float getRoamLimit()
  217.           void setRoamLimit(float maxRoamDel = 0.0)
  218.           void getRoamRate(float& x, float& y)
  219.           void getBackground(float& red, float& green, float& blue)
  220.           void setBackground(float red, float green, float blue)
  221.           iflColorModel getColorModel()
  222.           void setColormap(iflColormap& cmap)
  223.           ilStatus getColormap(iflColormap& cmap)
  224.           ilStatus getStatus()
  225.           void setStatus(ilStatus stat)
  226.           void setBackgroundDirty()
  227.  
  228.      VVVViiiieeeewwww mmmmaaaannnniiiippppuuuullllaaaattttiiiioooonnnn
  229.  
  230.           ilView* addView(ilImage* img, int index, int mode)
  231.           ilView* addView(ilImage* img, int mode = ilCenter)
  232.           ilStereoView* addStereoView(ilImage* imgL, ilImage* imgR,
  233.                                       int index, int mode)
  234.           ilStereoView* addStereoView(ilImage* imgL, ilImage* imgR,
  235.                                       int mode = ilCenter)
  236.           ilStereoView* addStereoView(ilImage* zImg, int zLeft,
  237.                                       int zRight, int index, int mode)
  238.           ilStereoView* addStereoView(ilImage* zImg, int zLeft = 0,
  239.                                       int zRight = 1, int mode = ilCenter)
  240.           ilView* addView(ilView* view, int index = 0, int mode = ilCenter)
  241.           void deleteView(ilView* view)
  242.           void deleteView(int index = 0)
  243.           void addViewChangeCallback(ilCallback* cb, int autoDelete=FALSE)
  244.           ilStatus removeViewChangeCallback(ilCallback* cb)
  245.           void push(ilView* view = NULL, int count = 0)
  246.           void pop(ilView* view = NULL, int count = 0)
  247.           void swap(ilView* view1, ilView* view2)
  248.           ilView* findView(int x, int y, int mode = ilDspCoord)
  249.           ilView* getView(int index = 0)
  250.           ilView* getView(ilImage* img)
  251.           int getViewIndex(ilView* view)
  252.           int getViewIndex(ilImage* img)
  253.           int getNumViews()
  254.           ilView* getLoc(float x, float y, float& ix, float& iy,
  255.                          int mode = ilLocIn)
  256.           ilView* setLoc(float ix, float iy, float x, float y,
  257.  
  258.  
  259.  
  260.                                                                         PPPPaaaaggggeeee 4444
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  268.  
  269.  
  270.  
  271.                          int mode = ilLocIn)
  272.           ilView* getPixel(int x, int y, iflPixel& pix)
  273.           ilView* setPixel(int x, int y, iflPixel& pix)
  274.           int isNop(ilView* view = NULL)
  275.           void setNop(int noOp, ilView* view = NULL)
  276.           void select(ilView* view = NULL)
  277.           void unselect(ilView* view = NULL)
  278.           int isSelected(ilView* view)
  279.           void setBorders(int enable, int mode = ilDefault)
  280.           void setBorderStyle(int style = ilViewBdrSolidLines)
  281.           void setBorderColor(float red, float green, float blue)
  282.           void setBorderWidth(int width)
  283.  
  284.      DDDDiiiissssppppllllaaaayyyy ooooppppeeeerrrraaaattttoooorrrr ssssuuuuppppppppoooorrrrtttt
  285.  
  286.           void setMouse(int x, int y, int mode = 0)
  287.           void getMouse(int& x, int& y)
  288.           void getMouse(int& x, int& y, iflOrientation orientation)
  289.           int findEdge(int x, int y, int margin = -1, int mode = ilDspCoord)
  290.  
  291.      DDDDiiiissssppppllllaaaayyyy ooooppppeeeerrrraaaattttoooorrrrssss
  292.  
  293.           void display(ilView* view = NULL, int vMode = ilCenter,
  294.                        int iMode = ilCenter)
  295.           void redraw(int x, int y, int nx, int ny,
  296.                       iflOrientation orientation = iflUpperLeftOrigin,
  297.                       int mode = ilDefault)
  298.           void redraw(int mode = ilDefault)
  299.           void paint(int x, int y, int nx, int ny,
  300.                      iflOrientation orientation = iflUpperLeftOrigin,
  301.                      ilView* view = NULL, int mode = 0)
  302.           void paint(ilView* view = NULL, int mode = 0)
  303.           void qPaint(ilMpNode* parent, int x, int y, int nx, int ny,
  304.                       iflOrientation orientation = iflUpperLeftOrigin,
  305.                       ilView* view = NULL, int mode = 0,
  306.                       ilMpManager** pMgr = NULL)
  307.           void qPaint(ilMpNode* parent, ilView* view = NULL, int mode = 0,
  308.                       ilMpManager** pMgr = NULL)
  309.           void moveView(int x, int y, ilView* view = NULL, int mode = ilRelVal)
  310.           void moveImg(float x, float y, ilView* view = NULL,
  311.                        int mode = ilRelVal)
  312.           void moveImgIdx(float x, float y, ilView* view,
  313.                        int idx, int mode)
  314.           void wipe(int x, int y, ilView* view = NULL, int mode = ilRelVal)
  315.           void wipeSplit(int x, int y, int mode = ilRelVal)
  316.           void wipeSize(int x, int y, ilView* view = NULL,
  317.                         int mode = ilDelVal|ilTopRight)
  318.           void split(int mode = ilAbsSplit|ilRowSplit|ilColSplit)
  319.           void alignImg(ilView* view = NULL, int mode = ilCenter)
  320.           void alignView(ilView* view = NULL, int mode = ilCenter,
  321.                          ilView* rView = NULL)
  322.           void update(int x = 0, int y = 0, int nx = 0, int ny = 0,
  323.  
  324.  
  325.  
  326.                                                                         PPPPaaaaggggeeee 5555
  327.  
  328.  
  329.  
  330.  
  331.  
  332.  
  333. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  334.  
  335.  
  336.  
  337.                       float imgX = 0, float imgY = 0, ilView* view = NULL,
  338.                       int mode = ilDelVal)
  339.           ilStatus save(ilImage* img, int x = 0, int y = 0, int mode = 0)
  340.  
  341.  
  342.  
  343. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  344.      iiiillllDDDDiiiissssppppllllaaaayyyy(((())))
  345.  
  346.           ilDisplay(Display* display, Window parentWin, int mode = ilDefault)
  347.           ilDisplay(Display* display, int width, int height,
  348.                     int attr=ilVisDoubleBuffer,
  349.                     int minComponentSize=8, int maxComponentSize=0,
  350.                     int mode = ilDefault,
  351.                     long eventMask = ExposureMask|KeyPressMask|
  352.                                      PointerMotionMask|PointerMotionHintMask|
  353.                                      ButtonPressMask|ButtonReleaseMask|
  354.                                      StructureNotifyMask)
  355.  
  356.  
  357.           Both versions of the constructor create an ilDisplay object to
  358.           manage views of images within an X window. The _m_o_d_e parameter is
  359.           used to specify the view mode when adding ilViews objects with
  360.           aaaaddddddddVVVViiiieeeewwww().  For example, iiiillllDDDDeeeeffffeeeerrrr could be used to add views without
  361.           painting each one as it is added to the display.
  362.  
  363.           Since OpenGL and X rendering can be mixed, the render mode is
  364.           determined automatically. If the X visual associated with the window
  365.           supports OpenGL rendering then OpenGL rendering will be used.
  366.           Otherwise X rendering will be used. Note that hardware acceleration
  367.           only occurs during OpenGL rendering.
  368.  
  369.           The second version of the constructor creates an X window as
  370.           specified by the various parameters. The created window will be
  371.           _w_i_d_t_h wide, _h_e_i_g_h_t high with the attributes specified by _a_t_t_r,
  372.           _m_i_n_C_o_m_p_o_n_e_n_t_S_i_z_e and _m_a_x_C_o_m_p_o_n_e_n_t_S_i_z_e for the visual class.  See
  373.           iiiillllXXXXWWWWiiiinnnnddddoooowwwwIIIImmmmgggg for more information. In addition, it will select the X
  374.           events passed in _e_v_e_n_t_M_a_s_k.
  375.  
  376.           A background view is created and is painted by default. However, if
  377.           ilDefer is passed in _m_o_d_e, painting will be deferred.  Also, an RGB
  378.           colormap will be loaded if needed. However, an application can load
  379.           a colormap or use the default colormap by passing ilDefaultCmap in
  380.           _m_o_d_e. This will cause ilDisplay to not load a colormap.
  381.  
  382.      aaaabbbboooorrrrtttt(((())))
  383.  
  384.           void abort()
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.                                                                         PPPPaaaaggggeeee 6666
  393.  
  394.  
  395.  
  396.  
  397.  
  398.  
  399. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  400.  
  401.  
  402.  
  403.           This method aborts any queued paint requests.  It works in
  404.           conjunction with the eeeennnnaaaabbbblllleeeeQQQQuuuueeeeuuuueeeeiiiinnnngggg() method.
  405.  
  406.      aaaaddddddddSSSStttteeeerrrreeeeooooVVVViiiieeeewwww(((())))
  407.  
  408.           ilStereoView* addStereoView(ilImage* imgL, ilImage* imgR,
  409.                                       int index, int mode)
  410.           ilStereoView* addStereoView(ilImage* imgL, ilImage* imgR,
  411.                                       int mode = ilCenter)
  412.           ilStereoView* addStereoView(ilImage* zImg, int zLeft = 0,
  413.                                       int zRight = 1, int mode = ilCenter)
  414.           ilStereoView* addStereoView(ilImage* zImg, int zLeft,
  415.                                       int zRight, int index, int mode)
  416.  
  417.  
  418.           These methods allow a pair of ilImages to be specified as the left
  419.           image and the right image of a stereo pair. In addition, a stereo
  420.           pair may be stored in a single image using the Z dimension. In this
  421.           case, the image is specified as _z_I_m_g. The Z index to the left image
  422.           is specified as _z_L_e_f_t and the Z index to the right image is
  423.           specified as _z_R_i_g_h_t. By default, zLeft is 0 and zRight is 1. The
  424.           advantage of this approach, is that a single IL chain can be used to
  425.           process the stereo pair, rather than having a chain to process each
  426.           image.
  427.  
  428.      aaaaddddddddVVVViiiieeeewwww(((())))
  429.  
  430.           ilView* addView(ilImage* img, int index, int mode)
  431.           ilView* addView(ilImage* img, int mode = ilCenter)
  432.           ilView* addView(ilView* view, int index = 0, int mode = ilCenter)
  433.  
  434.  
  435.           Creates an ilView for the image specified by, _i_m_g, and adds it to
  436.           the view stack at the index specified by, _i_d_x. By default, the view
  437.           is added to the top of the stack. If _i_d_x equals _i_l_L_a_s_t, the view is
  438.           added to the bottom of the stack. The mode parameter controls the
  439.           creation and position of the ilView. By default, the ilView is the
  440.           size of the image. However, if _i_l_C_l_i_p is passed in _m_o_d_e, then the
  441.           ilView will be clipped to the size of the display window. By
  442.           default, the view is painted after it is added to the stack.
  443.           However, if _i_l_D_e_f_e_r is passed, then painting is deferred. Also, an
  444.           alignment mode such as _i_l_C_e_n_t_e_r may be passed to control how the
  445.           image is aligned within the view and how the view is aligned within
  446.           the display window. Center alignment is used by default.
  447.  
  448.           Several versions of aaaaddddddddVVVViiiieeeewwww() are provided for convenience. The
  449.           version that takes an index, allows the position in the view stack
  450.           to be specified. Often however, putting the image on top of the
  451.           stack is acceptable and only the image and mode need to be
  452.           specified. Therefore, a second version is provided that only
  453.           requires an image and a mode to be specified.
  454.  
  455.  
  456.  
  457.  
  458.                                                                         PPPPaaaaggggeeee 7777
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  466.  
  467.  
  468.  
  469.      aaaaddddddddVVVViiiieeeewwwwCCCChhhhaaaannnnggggeeeeCCCCaaaallllllllbbbbaaaacccckkkk(((())))
  470.  
  471.           void addViewChangeCallback(ilCallback* cb, int autoDelete=FALSE)
  472.  
  473.  
  474.           This method adds a callback that will be triggered whenever a view
  475.           is added to or deleted from this object.  Either
  476.           ilViewChangeMethodCB or ilViewChangeFunctionCB can used with this
  477.           method. The callback method or function will have the prototype:
  478.  
  479.               func(UserArgType userArg, ilViewChangeArg* callerArg)
  480.  
  481.  
  482.           To define and use a view change callback to a member function you
  483.           might do something like:
  484.  
  485.               ...
  486.               ilStatus Bar::change(Foo*, ilViewChangeArg*) { ... }
  487.               ...
  488.               typedef ilViewChangeMethodCB<Bar,Foo*> ViewChangeCallback;
  489.  
  490.               Bar bar;
  491.               Foo foo;
  492.               ViewChangeCallback changeCb(&bar, Bar::change, &foo);
  493.  
  494.               disp->addViewChangeCallback(&changeCb);
  495.  
  496.  
  497.           The passed ilViewChangeArg contains two members:
  498.  
  499.           _r_e_a_s_o_n    The reason for this callback: either _i_l_V_i_e_w_A_d_d_e_d or
  500.                     _i_l_V_i_e_w_D_e_l_e_t_e_d.
  501.  
  502.           _v_i_e_w      The view being added or the view about to be deleted.
  503.  
  504.      aaaalllliiiiggggnnnnIIIImmmmgggg(((())))
  505.  
  506.           void alignImg(ilView* view = NULL, int mode = ilCenter)
  507.  
  508.  
  509.           Aligns the image in the specified view based on _m_o_d_e. If NULL is
  510.           passed, then the image in all views in the view stack are aligned
  511.           (expect those with nop flag set). For example, if ilCenter is
  512.           specified, the images are centered within the view.  Similarly, if
  513.           ilBottomLeft is specified, the lower left corner of the image is
  514.           aligned to the lower left corner of the view. See _i_l/_i_l_D_i_s_p_l_a_y_D_e_f._h
  515.           for a complete list of modes.
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.                                                                         PPPPaaaaggggeeee 8888
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  532.  
  533.  
  534.  
  535.      aaaalllliiiiggggnnnnVVVViiiieeeewwww(((())))
  536.  
  537.           void alignView(ilView* view = NULL, int mode = ilCenter,
  538.                          ilView* rView = NULL)
  539.  
  540.  
  541.           Aligns the specified view to the reference view specified in _r_V_i_e_w.
  542.           If NULL is passed then all views are aligned (except those with nop
  543.           flag set). The two views are aligned based on bit flags passed in
  544.           _m_o_d_e. For example, it ilCenter is specified, the center of the view
  545.           is aligned to the center of the reference view. Similarly, if
  546.           ilTopRight is specified, the upper right corner of the view is
  547.           aligned to the upper right corner of the reference view. If NULL is
  548.           passed in rView, the background view in ilDisplay is used. See
  549.           _i_l/_i_l_D_i_s_p_l_a_y_D_e_f._h for a complete list of modes.
  550.  
  551.      ccccaaaallllccccWWWWiiiinnnnddddoooowwwwSSSSiiiizzzzeeee(((())))
  552.  
  553.           void calcWindowSize(int& width, int& height)
  554.  
  555.  
  556.           This method computes a window size that won't clip any of the images
  557.           in the current set of views, this size is clipped to the size of the
  558.           screen.
  559.  
  560.      ddddeeeelllleeeetttteeeeVVVViiiieeeewwww(((())))
  561.  
  562.           void deleteView(ilView* view)
  563.           void deleteView(int index = 0)
  564.  
  565.  
  566.           Removes the specified view from the view stack and deletes the
  567.           ilView.  The display is then repainted.
  568.  
  569.      ddddeeeessssttttrrrrooooyyyyNNNNoooottttiiiiffffyyyy(((())))
  570.  
  571.           void destroyNotify()
  572.  
  573.  
  574.           This method is intended to be called when the X window used by this
  575.           object has been destroyed, typically when a DestroyNotify X event is
  576.           handled.
  577.  
  578.      ddddiiiissssppppllllaaaayyyy(((())))
  579.  
  580.           void display(ilView* view = NULL, int vMode =ilCenter,
  581.                        int iMode =ilCenter)
  582.  
  583.  
  584.           This function resizes, aligns, and paints the specified view. If
  585.           NULL is passed, then all views are operated on (except those with
  586.           nop flag set). If ilDefer is specified, then painting is deferred.
  587.  
  588.  
  589.  
  590.                                                                         PPPPaaaaggggeeee 9999
  591.  
  592.  
  593.  
  594.  
  595.  
  596.  
  597. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  598.  
  599.  
  600.  
  601.           The view is resized to the size of the image. However, if ilClip is
  602.           specified, the view is clipped to the size of the display. The view
  603.           is aligned as specified in _v_M_o_d_e, and the image mapped to the view
  604.           is aligned as specified in _i_M_o_d_e.
  605.  
  606.      eeeennnnaaaabbbblllleeeeAAAAuuuuttttooooAAAAbbbboooorrrrtttt(((())))
  607.  
  608.           void enableAutoAbort(int enable=TRUE)
  609.  
  610.  
  611.           This method enables automatic aborting of queued requests; when this
  612.           mode is turned on any new painting operations will automatically
  613.           cancel paint operations in progress. This mode only makes sense if
  614.           queueing is enabled (see eeeennnnaaaabbbblllleeeeQQQQuuuueeeeuuuueeeeiiiinnnngggg()).
  615.  
  616.      eeeennnnaaaabbbblllleeeeCCCCaaaallllllllbbbbaaaacccckkkk(((())))
  617.  
  618.           void enableCallback(int enable = TRUE)
  619.  
  620.  
  621.           This member function enables (_T_r_u_e) or disables (_F_a_l_s_e) the post-
  622.           render callback setup with sssseeeettttCCCCaaaallllllllbbbbaaaacccckkkk(). Note that the callback
  623.           must be set and enabled to be operable.
  624.  
  625.      eeeennnnaaaabbbblllleeeeFFFFrrrroooonnnnttttRRRReeeeddddrrrraaaawwww(((())))
  626.  
  627.           void enableFrontRedraw(int enable)
  628.  
  629.  
  630.           This member function enables or disables drawing to the front buffer
  631.           when rrrreeeeddddrrrraaaawwww() is called. This allows better visual feedback when in
  632.           double buffer mode.  If _T_r_u_e is passed then front redraw is enabled.
  633.           Otherwise, it is disabled.
  634.  
  635.      eeeennnnaaaabbbblllleeeeQQQQuuuueeeeuuuueeeeiiiinnnngggg(((())))
  636.  
  637.           void enableQueueing(int enable=TRUE)
  638.  
  639.  
  640.           This method controls whether queued painting is actually allowed,
  641.           the default mode is that queued painting will not be done.  When the
  642.           mode is enabled, call to various display operation (like mmmmoooovvvveeeeIIIImmmmgggg())
  643.           will return before the rendering is completed.  When another
  644.           operations is requested it will be started before waiting for the
  645.           last operation to complete to allow overlapped prefetching of data.
  646.           This mode is currently only supported on MP machines.
  647.  
  648.           Completion of the queued operation can be ensured by calling the
  649.           ssssyyyynnnnccccPPPPaaaaiiiinnnntttt() method.  Queued operations can be aborted with the
  650.           aaaabbbboooorrrrtttt() method.
  651.  
  652.  
  653.  
  654.  
  655.  
  656.                                                                        PPPPaaaaggggeeee 11110000
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  664.  
  665.  
  666.  
  667.      ffffiiiinnnnddddEEEEddddggggeeee(((())))
  668.  
  669.           int findEdge(int x, int y, int margin = -1, int mode = ilDspCoord)
  670.  
  671.  
  672.           Returns the edge or edges within _m_a_r_g_i_n pixels of _x and _y.  The view
  673.           stack is searched from top to bottom so that edges of the top view
  674.           are returned. However, ilNoEdge is returned if no edge is found and
  675.           ilNoView is returned if there is no view at the location specified
  676.           by _x and _y.
  677.  
  678.      ffffiiiinnnnddddVVVViiiieeeewwww(((())))
  679.  
  680.           ilView* findView(int x, int y, int mode = ilDspCoord)
  681.  
  682.  
  683.           Returns a pointer to the top-most ilView found at location (_x,_y)
  684.           within the display. If there is no view at (x,y), NULL is returned.
  685.           If ilDspCoord is passed in mode (default), then the (x,y)
  686.           coordinates are interpreted relative to the display window. If
  687.           ilScrCoord is passed in mode, then the (x,y) coordinates are
  688.           interpreted relative to the screen.
  689.  
  690.      fffflllluuuusssshhhh(((())))
  691.  
  692.           void flush()
  693.  
  694.  
  695.           Flushes graphics commands that may be buffered. Usually, it is not
  696.           necessary to call flush in interactive applications.
  697.  
  698.      ggggeeeettttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd(((())))
  699.  
  700.           void getBackground(float& red, float& green, float& blue)
  701.  
  702.  
  703.           Returns the current background color in _r_e_d, _g_r_e_e_n and _b_l_u_e.  See
  704.           setBackground()
  705.  
  706.      ggggeeeettttCCCCaaaallllllllbbbbaaaacccckkkk(((())))
  707.  
  708.           void getCallback(ilCallback*& prepare, ilCallback*& render,
  709.                            ilCallback*& finish)
  710.  
  711.  
  712.           Returns pointers to the _p_r_e_p_a_r_e callback, _r_e_n_d_e_r callback and _f_i_n_i_s_h
  713.           callback in the repective parameters. These callbacks were
  714.           previousely set with sssseeeettttCCCCaaaallllllllbbbbaaaacccckkkk(). See iiiillllVVVViiiieeeewwww and iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk
  715.           for more information.
  716.  
  717.  
  718.  
  719.  
  720.  
  721.  
  722.                                                                        PPPPaaaaggggeeee 11111111
  723.  
  724.  
  725.  
  726.  
  727.  
  728.  
  729. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  730.  
  731.  
  732.  
  733.      ggggeeeettttCCCCoooolllloooorrrrMMMMooooddddeeeellll(((())))
  734.  
  735.           iflColorModel getColorModel()
  736.  
  737.  
  738.           Returns the color model of the display image.
  739.  
  740.      ggggeeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  741.  
  742.           ilStatus getColormap(iflColormap& cmap)
  743.  
  744.  
  745.           Returns the current colormap in _l_u_t. The colormap is used by
  746.           iiiillllXXXXDDDDiiiissssppppllllaaaayyyyIIIImmmmgggg or iiiillllGGGGLLLLDDDDiiiissssppppllllaaaayyyyIIIImmmmgggg, depending on the render mode.
  747.  
  748.      ggggeeeettttDDDDiiiissssppppllllaaaayyyy(((())))
  749.  
  750.           Display* getDisplay()
  751.  
  752.  
  753.           Returns the X Display currently being used.
  754.  
  755.      ggggeeeettttGGGGLLLLXXXXCCCCoooonnnntttteeeexxxxtttt(((())))
  756.  
  757.           GLXContext getGLXContext()
  758.  
  759.  
  760.           This method returns the OpenGL rendering context used by IL.  This
  761.           can be used to create display lists in a user context that can be
  762.           shared with the IL context, and thus used in the rendering
  763.           callbacks.  To do this the user context must be created specifying
  764.           the IL context as the _s_h_a_r_e_L_i_s_t parameter of ggggllllXXXXCCCCrrrreeeeaaaatttteeeeCCCCoooonnnntttteeeexxxxtttt().
  765.  
  766.      ggggeeeettttIIIILLLLDDDDiiiissssppppllllaaaayyyy(((())))
  767.  
  768.           Display* getILDisplay()
  769.  
  770.  
  771.           This method returns the internal Display* that IL uses.  This is not
  772.           intended for use outside of IL.
  773.  
  774.      ggggeeeettttLLLLoooocccc(((())))
  775.  
  776.           ilView* getLoc(float x, float y, float& ix, float& iy,
  777.                          int mode = ilLocIn)
  778.  
  779.  
  780.           This function finds the view at (_x, _y) and returns the corresponding
  781.           location in the image in _i_x and _i_y. If _i_l_L_o_c_I_n is passed in _m_o_d_e,
  782.           the location is returned in the input space of the image.  If
  783.           _i_l_L_o_c_O_u_t is passed in _m_o_d_e, the location is returned in the output
  784.           space of the image. For example, if an ilRotZoomIng is mapped to the
  785.  
  786.  
  787.  
  788.                                                                        PPPPaaaaggggeeee 11112222
  789.  
  790.  
  791.  
  792.  
  793.  
  794.  
  795. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  796.  
  797.  
  798.  
  799.           view and _i_l_L_o_c_I_n is specified, _i_x and _i_y will correspond to the
  800.           location in the unzoomed image. However, if _i_l_L_o_c_O_u_t is specified,
  801.           _i_x and _i_y correspond to the location in the zoomed image.
  802.  
  803.      ggggeeeettttMMMMaaaarrrrggggiiiinnnn(((())))
  804.  
  805.           int getMargin()
  806.  
  807.  
  808.           Returns the current margin in pixels that is used for ffffiiiinnnnddddEEEEddddggggeeee().
  809.  
  810.      ggggeeeettttMMMMoooouuuusssseeee(((())))
  811.  
  812.           void getMouse(int& x, int& y)
  813.           void getMouse(int& x, int& y, iflOrientation orientation)
  814.  
  815.  
  816.           Returns the current XY location of the mouse. The mouse position is
  817.           set with sssseeeettttMMMMoooouuuusssseeee(((()))) and is updated by display operators that are
  818.           passed _i_l_R_e_l_V_a_l parameter mode. The values _x and _y, are returned for
  819.           the specified orientation. The first version, uses the current _e_v_e_n_t
  820.           orientation. This method is useful for some interactive
  821.           applications.
  822.  
  823.      ggggeeeettttNNNNuuuummmmVVVViiiieeeewwwwssss(((())))
  824.  
  825.           int getNumViews()
  826.  
  827.  
  828.           Returns the number of ilViews in the view stack. The background view
  829.           can not be accessed and is not included in the count.
  830.  
  831.      ggggeeeettttPPPPiiiixxxxeeeellll(((())))
  832.  
  833.           ilView* getPixel(int x, int y, iflPixel& pix)
  834.  
  835.  
  836.           Copies into _p_i_x the pixel value at coordinates (_x, _y), in ilDisplay
  837.           coordinates. The pixel value is obtained from _v_i_e_w.  If _v_i_e_w is
  838.           NULL, then the view at _x,_y is found first.
  839.  
  840.      ggggeeeettttPPPPoooossss(((())))
  841.  
  842.           void getPos(int& x, int& y)
  843.  
  844.  
  845.           Returns the current position of the ilDisplayImg within the display
  846.           window. ilDisplay creates a ilDisplayImg (X or GL) to perform the
  847.           actual rendering to the frame buffer. It is maintained at position
  848.           0, 0 within the display window.
  849.  
  850.  
  851.  
  852.  
  853.  
  854.                                                                        PPPPaaaaggggeeee 11113333
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  862.  
  863.  
  864.  
  865.      ggggeeeettttRRRRooooaaaammmmLLLLiiiimmmmiiiitttt(((())))
  866.  
  867.           float getRoamLimit()
  868.  
  869.  
  870.           Returns the roam limit previously set with sssseeeettttRRRRooooaaaammmmLLLLiiiimmmmiiiitttt().  The roam
  871.           limit causes image movement to be limited in order to facilitate
  872.           smooth roaming with mmmmoooovvvveeeeIIIImmmmgggg() or mmmmoooovvvveeeeIIIImmmmggggIIIIddddxxxx(). The roam limit is
  873.           used to calculate the maximum roam rate in x and y for a given
  874.           direction.
  875.  
  876.      ggggeeeettttRRRRooooaaaammmmRRRRaaaatttteeee(((())))
  877.  
  878.           void getRoamRate(float& x, float& y)
  879.  
  880.  
  881.           Returns the horizontal and vertical roam rate in _x and _y.  If a roam
  882.           limit has been set with sssseeeettttRRRRooooaaaammmmLLLLiiiimmmmiiiitttt(), then image movement may be
  883.           clipped when using mmmmoooovvvveeeeIIIImmmmgggg() or mmmmoooovvvveeeeIIIImmmmggggIIIIddddxxxx().  The returned values
  884.           give the number of pixels the image was moved in the x and y
  885.           directions. The roam rate is updated each time mmmmoooovvvveeeeIIIImmmmgggg() or
  886.           mmmmoooovvvveeeeIIIImmmmggggIIIIddddxxxx() is called.
  887.  
  888.      ggggeeeettttSSSSiiiizzzzeeee(((())))
  889.  
  890.           void getSize(int& x, int& y)
  891.  
  892.  
  893.           Returns the size of the ilDisplayImg into _x and _y.
  894.  
  895.      ggggeeeettttSSSSttttaaaattttuuuussss(((())))
  896.  
  897.           ilStatus getStatus()
  898.  
  899.  
  900.           Returns the current status. See /_u_s_r/_i_n_c_l_u_d_e/_i_l/_i_l_E_r_r_o_r._h for a list
  901.           of error codes.
  902.  
  903.      ggggeeeettttVVVViiiieeeewwww(((())))
  904.  
  905.           ilView* getView(ilImage* img)
  906.           ilView* getView(int index = 0)
  907.  
  908.  
  909.           Returns a pointer to the ilView that corresponds to _i_d_x in the view
  910.           stack, or the bottom-most ilView containing _i_m_g. If no ilView is
  911.           found, NULL is returned. Note that the back view can not be
  912.           accessed.
  913.  
  914.  
  915.  
  916.  
  917.  
  918.  
  919.  
  920.                                                                        PPPPaaaaggggeeee 11114444
  921.  
  922.  
  923.  
  924.  
  925.  
  926.  
  927. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  928.  
  929.  
  930.  
  931.      ggggeeeettttVVVViiiieeeewwwwIIIInnnnddddeeeexxxx(((())))
  932.  
  933.           int getViewIndex(ilImage* img)
  934.           int getViewIndex(ilView* view)
  935.  
  936.  
  937.           Returns the index into the display's ilView corresponding to _v_i_e_w
  938.           or, the index of the bottom-most ilView containing _i_m_g.  If _v_i_e_w or
  939.           _i_m_g is not in the list, ilNoListIndex is returned.
  940.  
  941.      ggggeeeettttVVVViiiissssiiiibbbblllleeeeAAAArrrreeeeaaaa(((())))
  942.  
  943.           void getVisibleArea(int& x, int& y, int& nx, int& ny)
  944.  
  945.  
  946.           Returns the current visible area. If the area is valid, then
  947.           painting is limited to this area. This feature is useful for
  948.           scrolled windows.  See sssseeeettttVVVViiiissssiiiibbbblllleeeeAAAArrrreeeeaaaa() for more information.
  949.  
  950.      ggggeeeettttWWWWiiiinnnnddddoooowwww(((())))
  951.  
  952.           Window getWindow()
  953.  
  954.  
  955.           Returns the X Window currently being used.
  956.  
  957.      ggggeeeettttXXXXWWWWiiiinnnnddddoooowwwwIIIImmmmgggg(((())))
  958.  
  959.           ilXWindowImg* getXWindowImg()
  960.  
  961.  
  962.           This method returns the ilXWindowImg created by this object.  It is
  963.           used for all rendering operations.
  964.  
  965.      iiiissssAAAAuuuuttttooooAAAAbbbboooorrrrttttEEEEnnnnaaaabbbblllleeeedddd(((())))
  966.  
  967.           int isAutoAbortEnabled()
  968.  
  969.  
  970.           Returns TRUE if auto-abort is enabled, FALSE otherwise.  See
  971.           eeeennnnaaaabbbblllleeeeAAAAuuuuttttooooAAAAbbbboooorrrrtttt().
  972.  
  973.      iiiissssCCCCaaaallllllllbbbbaaaacccckkkkEEEEnnnnaaaabbbblllleeeedddd(((())))
  974.  
  975.           int isCallbackEnabled()
  976.  
  977.  
  978.  
  979.  
  980.           Returns _T_R_U_E if the post-render callback is enabled. Otherwise it
  981.           rerutns _F_A_L_S_E. See sssseeeettttCCCCaaaallllllllbbbbaaaacccckkkk() and eeeennnnaaaabbbblllleeeeCCCCaaaallllllllbbbbaaaacccckkkk().
  982.  
  983.  
  984.  
  985.  
  986.                                                                        PPPPaaaaggggeeee 11115555
  987.  
  988.  
  989.  
  990.  
  991.  
  992.  
  993. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  994.  
  995.  
  996.  
  997.      iiiissssDDDDeeeeffffeeeerrrr(((())))
  998.  
  999.           int isDefer(ilView* view = NULL)
  1000.  
  1001.  
  1002.           Returns the state of the defer flag for the specified view. If _v_i_e_w
  1003.           is NULL, the state of the defer flag on ilDisplay is returned.
  1004.           Returns TRUE if painting is deferred, FALSE otherwise.
  1005.  
  1006.      iiiissssDDDDoooouuuubbbblllleeeeBBBBuuuuffffffffeeeerrrr(((())))
  1007.  
  1008.           int isDoubleBuffer()
  1009.  
  1010.  
  1011.           Returns TRUE if double buffer mode is set, FALSE otherwise.
  1012.  
  1013.      iiiissssFFFFrrrroooonnnnttttRRRReeeeddddrrrraaaawwwwEEEEnnnnaaaabbbblllleeeedddd(((())))
  1014.  
  1015.           int isFrontRedrawEnabled()
  1016.  
  1017.  
  1018.           This member function returns _T_R_U_E if front redraw is enabled,
  1019.           otherwise it returns _F_A_L_S_E. See also eeeennnnaaaabbbblllleeeeFFFFrrrroooonnnnttttRRRReeeeddddrrrraaaawwww().
  1020.  
  1021.      iiiissssNNNNoooopppp(((())))
  1022.  
  1023.           int isNop(ilView* view = NULL)
  1024.  
  1025.  
  1026.           Returns TRUE if the nop flag is set on the specified view, FALSE
  1027.           otherwise.  If view is NULL, then the view on the top of the stack
  1028.           is tested.
  1029.  
  1030.      iiiissssQQQQuuuueeeeuuuueeeeiiiinnnnggggEEEEnnnnaaaabbbblllleeeedddd(((())))
  1031.  
  1032.           int isQueueingEnabled()
  1033.  
  1034.  
  1035.           Returns TRUE if queued rendering is enabled, FALSE otherwise.  See
  1036.           eeeennnnaaaabbbblllleeeeQQQQuuuueeeeuuuueeeeiiiinnnngggg().
  1037.  
  1038.      iiiissssRRRRggggbbbb(((())))
  1039.  
  1040.           int isRgb()
  1041.  
  1042.  
  1043.           Returns the GL color mode: TRUE for RGBmode, FALSE for colormap.
  1044.  
  1045.  
  1046.  
  1047.  
  1048.  
  1049.  
  1050.  
  1051.  
  1052.                                                                        PPPPaaaaggggeeee 11116666
  1053.  
  1054.  
  1055.  
  1056.  
  1057.  
  1058.  
  1059. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1060.  
  1061.  
  1062.  
  1063.      iiiissssSSSSeeeelllleeeecccctttteeeedddd(((())))
  1064.  
  1065.           int isSelected(ilView* view)
  1066.  
  1067.  
  1068.           Returns TRUE if the specified view is selected, FALSE otherwise.
  1069.           When an ilView is selected, its nop flag is FALSE and its borders
  1070.           are enabled.
  1071.  
  1072.      iiiissssSSSStttteeeerrrreeeeoooo(((())))
  1073.  
  1074.           int isStereo()
  1075.  
  1076.  
  1077.           Returns TRUE if stereo viewing mode is available, FALSE otherwise.
  1078.           ilDisplay supports both monoscopic and stereoscopic views
  1079.           simultaneously within the same GL window. Stereo is only supported
  1080.           on InfiniteReality, RealityEngine and Impact graphics systems.
  1081.  
  1082.      mmmmaaaappppTTTTiiiilllleeee(((())))
  1083.  
  1084.           void mapTile(iflOrientation fromOrientation, iflTile2Dfloat& tile,
  1085.                        iflOrientation toOrientation=iflOrientation(0))
  1086.           void mapTile(iflOrientation fromOrientation, iflTile2Dint& tile,
  1087.                        iflOrientation toOrientation=iflOrientation(0))
  1088.  
  1089.  
  1090.           Maps the specified _t_i_l_e from the _f_r_o_m_O_r_i_e_n_t_a_t_i_o_n to the
  1091.           _t_o_O_r_i_e_n_t_a_t_i_o_n relative to the ilXWindowImg used by ilDisplay. By
  1092.           default, the orientation of ilDisplay (upper-left) is used for
  1093.           _t_o_O_r_i_e_n_t_a_t_i_o_n.
  1094.  
  1095.      mmmmaaaappppXXXXYYYY(((())))
  1096.  
  1097.           void mapXY(iflOrientation fromOrientation, float& x, float& y,
  1098.                      iflOrientation toOrientation=iflOrientation(0))
  1099.           void mapXY(iflOrientation fromOrientation, int& x, int& y,
  1100.                      iflOrientation toOrientation=iflOrientation(0))
  1101.  
  1102.  
  1103.           Maps _i_x and _i_y from _f_r_o_m_O_r_i_e_n_t_a_t_i_o_n to _t_o_O_r_i_e_n_t_a_t_i_o_n and returns the
  1104.           result in _o_x and _o_y. By default, the orientation of ilDisplay
  1105.           (upper-left) is used for _t_o_O_r_i_e_n_t_a_t_i_o_n.
  1106.  
  1107.  
  1108.  
  1109.  
  1110.  
  1111.  
  1112.  
  1113.  
  1114.  
  1115.  
  1116.  
  1117.  
  1118.                                                                        PPPPaaaaggggeeee 11117777
  1119.  
  1120.  
  1121.  
  1122.  
  1123.  
  1124.  
  1125. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1126.  
  1127.  
  1128.  
  1129.      mmmmoooovvvveeeeIIIImmmmgggg(((())))
  1130.  
  1131.           void moveImg(float x, float y, ilView* view = NULL,
  1132.                        int mode = ilRelVal)
  1133.           void moveImgIdx(float x, float y, ilView* view,
  1134.                        int idx, int mode)
  1135.  
  1136.  
  1137.           These functions move the image within the specified _v_i_e_w. If NULL is
  1138.           passed as _v_i_e_w, then the images are moved in all views in the stack
  1139.           (except those with nop flag set). The image is moved as specified by
  1140.           _x and _y. The _m_o_d_e controls how the function operates. If ilClip is
  1141.           passed in mode, the image position is clipped to prevent moving
  1142.           beyond the edge of the image. However, by default, the image can be
  1143.           moved beyond its edge, exposing the image's fill value. The view is
  1144.           painted after the image has been moved, unless ilDefer is passed in
  1145.           mode.
  1146.  
  1147.           The mode also controls how the _x and _y parameters are interpreted.
  1148.           If ilDelVal is passed in _m_o_d_e, x and y specify the change (delta) in
  1149.           the image position. If ilAbsVal is specified, x and y specify the
  1150.           new position of the image. Note that the image position corresponds
  1151.           to the upper-left corner of the view, rather than the origin of the
  1152.           image.
  1153.  
  1154.           If ilRelVal is passed in _m_o_d_e, then x and y are interpreted relative
  1155.           to a starting xy coordinate maintained within ilDisplay.  Typically,
  1156.           ilRelVal is used for interactive applications that use the mouse to
  1157.           control movement. The sssseeeettttMMMMoooouuuusssseeee() function on ilDisplay must be
  1158.           called to set the starting xy location. Then the difference between
  1159.           the starting xy location and the specified xy location is used to
  1160.           adjust the image position. The starting xy location is then updated.
  1161.           Specifying ilOldRel has the same effect as ilRelVal except that the
  1162.           starting xy location is not updated.
  1163.  
  1164.           The portion of the image being displayed resides in the cache of the
  1165.           input image. So as the image is moved within the view, old pages are
  1166.           discarded and new pages are brought into the cache.
  1167.  
  1168.           Note that if a roam limit has been set with sssseeeettttRRRRooooaaaammmmLLLLiiiimmmmiiiitttt(), that
  1169.           image movement may be clipped. See setRoamLimit() for more
  1170.           information.
  1171.  
  1172.           For those views displaying multiple images (i.e., iiiillllSSSStttteeeerrrreeeeooooVVVViiiieeeewwww), the
  1173.           mmmmoooovvvveeeeIIIImmmmggggIIIIddddxxxx() iiiillllDDDDiiiissssppppllllaaaayyyyMMMMoooovvvveeeeIIIImmmmggggIIIIddddxxxx() function allows independent
  1174.           movement of each image within the view. For stereo views, the valid
  1175.           values for _i_d_x are ilViewImgPairLeft and ilViewImgPairRight.
  1176.  
  1177.      mmmmoooovvvveeeeVVVViiiieeeewwww(((())))
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.                                                                        PPPPaaaaggggeeee 11118888
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1192.  
  1193.  
  1194.  
  1195.           void moveView(int x, int y, ilView* view = NULL, int mode = ilRelVal)
  1196.  
  1197.  
  1198.           This function moves the specified view within the display. If NULL
  1199.           is passed, then the image is moved in all views in the stack (except
  1200.           those with nop flag set). The image is moved as specified by _x and
  1201.           _y. The _m_o_d_e controls how the function operates. If ilClip is passed
  1202.           in mode, the view position is clipped to prevent moving beyond the
  1203.           edge of the display. However, by default, the view can be moved
  1204.           beyond the edge of the display. The view is painted after the view
  1205.           has been moved, unless ilDefer is passed in mode. The mode also
  1206.           controls how the _x and _y parameters are interpreted.
  1207.  
  1208.           If ilDelVal is passed in _m_o_d_e, _x and _y specify the change (delta) in
  1209.           the view position. If ilAbsVal is specified, x and y specify the new
  1210.           position of the view. Note that the view position corresponds to the
  1211.           upper-left corner of the view relative to the upper-left corner of
  1212.           the display.
  1213.  
  1214.           If ilRelVal is passed in _m_o_d_e, then x and y are interpreted relative
  1215.           to a starting xy coordinate maintained within ilDisplay. Typically,
  1216.           ilRelVal is used for interactive applications that use the mouse to
  1217.           control movement. The sssseeeettttMMMMoooouuuusssseeee() function on ilDisplay must be
  1218.           called to set the starting _x_y location. Then the difference between
  1219.           the starting _x_y location and the specified _x_y location is used to
  1220.           adjust the view position. The starting _x_y location is then updated.
  1221.           Specifying ilOldRel has the same effect as ilRelVal except that the
  1222.           starting _x_y location is not updated.
  1223.  
  1224.      ppppaaaaiiiinnnntttt(((())))
  1225.  
  1226.           void paint(ilView* view = NULL, int mode = 0)
  1227.           void paint(int x, int y, int nx, int ny,
  1228.                      iflOrientation orientation = iflUpperLeftOrigin,
  1229.                      ilView* view = NULL, int mode = 0)
  1230.  
  1231.  
  1232.           This function paints the specified view if it needs to be painted.
  1233.           If _N_U_L_L is passed, then all views are painted if needed (except
  1234.           those with nop flag set). If an area is specified with origin _x, _y
  1235.           and size _n_x, _n_y then only the specified area is painted. The area
  1236.           parameters are interpreted based on the _o_r_i_e_n_t_a_t_i_o_n specified.
  1237.  
  1238.           If iiiillllPPPPaaaaiiiinnnnttttEEEExxxxppppoooosssseeee is passed in _m_o_d_e, the view is forced to be
  1239.           painted. If iiiillllDDDDeeeeffffeeeerrrr is passed in _m_o_d_e, or if the view is deferred
  1240.           (see sssseeeettttDDDDeeeeffffeeeerrrr()), then the view is not be painted. The view
  1241.           position, size, and image position are unaffected.
  1242.  
  1243.      ppppoooopppp(((())))
  1244.  
  1245.  
  1246.  
  1247.  
  1248.  
  1249.  
  1250.                                                                        PPPPaaaaggggeeee 11119999
  1251.  
  1252.  
  1253.  
  1254.  
  1255.  
  1256.  
  1257. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1258.  
  1259.  
  1260.  
  1261.           void pop(ilView* view = NULL, int count = 0)
  1262.  
  1263.  
  1264.           Pops _v_i_e_w up _c_o_u_n_t positions in the stack. If _c_o_u_n_t is zero, the
  1265.           view is popped to the top of the stack. If _v_i_e_w is NULL, the bottom
  1266.           view is popped.
  1267.  
  1268.      ppppuuuusssshhhh(((())))
  1269.  
  1270.           void push(ilView* view = NULL, int count = 0)
  1271.  
  1272.  
  1273.           Pushes _v_i_e_w down _c_o_u_n_t positions in the stack. If _c_o_u_n_t is zero, the
  1274.           view is pushed to the bottom of the stack. If _v_i_e_w is NULL, the top
  1275.           view is pushed.
  1276.  
  1277.      qqqqPPPPaaaaiiiinnnntttt(((())))
  1278.  
  1279.           void qPaint(ilMpNode* parent, ilView* view = NULL, int mode = 0,
  1280.                       ilMpManager** pMgr = NULL)
  1281.           void qPaint(ilMpNode* parent, int x, int y, int nx, int ny,
  1282.                       iflOrientation orientation = iflUpperLeftOrigin,
  1283.                       ilView* view = NULL, int mode = 0,
  1284.                       ilMpManager** pMgr = NULL)
  1285.  
  1286.  
  1287.           This function is identical to ppppaaaaiiiinnnntttt() except that the paint
  1288.           operation is queued and the function returns immediately. This
  1289.           allows the application thread to return to processing events and
  1290.           thus provide a responsive UI. See iiiillllMMMMppppMMMMaaaannnnaaaaggggeeeerrrr and iiiillllMMMMppppNNNNooooddddeeee for more
  1291.           information.
  1292.  
  1293.           If an iiiillllMMMMppppNNNNooooddddeeee is passed as _p_a_r_e_n_t, the paint requests are queued on
  1294.           the parent node. If _p_M_g_r is specified, the iiiillllMMMMppppMMMMaaaannnnaaaaggggeeeerrrr created to
  1295.           queue the paint requests is returned. This allows an application to
  1296.           setup a completion callback or wait for the queued requests to
  1297.           complete.
  1298.  
  1299.      rrrreeeeddddrrrraaaawwww(((())))
  1300.  
  1301.           void redraw(int mode = ilDefault)
  1302.           void redraw(int x, int y, int nx, int ny,
  1303.                       iflOrientation orientation = iflUpperLeftOrigin,
  1304.                       int mode = ilDefault)
  1305.  
  1306.  
  1307.           Resizes the display and back view to the size of the display window
  1308.           and repaints all views. If an area is specified with origin _x, _y and
  1309.           size _n_x, _n_y then only the specified area is painted.  If iiiillllDDDDeeeeffffeeeerrrr is
  1310.           passed in _m_o_d_e, the display and back view are resized but not
  1311.           painted and all views are unaffected.  This function is useful when
  1312.           an expose event occurs.
  1313.  
  1314.  
  1315.  
  1316.                                                                        PPPPaaaaggggeeee 22220000
  1317.  
  1318.  
  1319.  
  1320.  
  1321.  
  1322.  
  1323. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1324.  
  1325.  
  1326.  
  1327.      rrrreeeemmmmoooovvvveeeeVVVViiiieeeewwwwCCCChhhhaaaannnnggggeeeeCCCCaaaallllllllbbbbaaaacccckkkk(((())))
  1328.  
  1329.           ilStatus removeViewChangeCallback(ilCallback* cb)
  1330.  
  1331.  
  1332.           This method removes a view add/delete callback previously added with
  1333.           aaaaddddddddVVVViiiieeeewwwwCCCChhhhaaaannnnggggeeeeCCCCaaaallllllllbbbbaaaacccckkkk().
  1334.  
  1335.      ssssaaaavvvveeee(((())))
  1336.  
  1337.           ilStatus save(ilImage* img, int x = 0, int y = 0, int mode = 0)
  1338.  
  1339.  
  1340.           This function saves a region of the display area into the ilImage
  1341.           specified by _i_m_g. The region that is saved starts at the location
  1342.           specified by _x and _y and is the size of _i_m_g. By default, borders are
  1343.           not painted. However, if ilPaintBorder is passed in _m_o_d_e, then
  1344.           borders are painted on views with borders turned on.
  1345.  
  1346.      sssseeeelllleeeecccctttt(((())))
  1347.  
  1348.           void select(ilView* view = NULL)
  1349.  
  1350.  
  1351.           Selects the specified view. If NULL is passed, then all views in the
  1352.           view stack are selected. When a view is selected, its nop flag is
  1353.           FALSE and its borders are enabled.
  1354.  
  1355.      sssseeeettttBBBBaaaacccckkkkggggrrrroooouuuunnnndddd(((())))
  1356.  
  1357.           void setBackground(float red, float green, float blue)
  1358.  
  1359.  
  1360.           Sets the ilDisplay's background color to that specified by _r_e_d,
  1361.           _g_r_e_e_n and _b_l_u_e. The values are assumed to be normalized to the range
  1362.           0.0 to 1.0.
  1363.  
  1364.      sssseeeettttBBBBaaaacccckkkkggggrrrroooouuuunnnnddddDDDDiiiirrrrttttyyyy(((())))
  1365.  
  1366.           void setBackgroundDirty()
  1367.  
  1368.  
  1369.           Indicates that the ilDisplay's background needs to be repainted for
  1370.           some external reason (e.g. graphics drawn on top that need to be
  1371.           updated).
  1372.  
  1373.      sssseeeettttBBBBoooorrrrddddeeeerrrrCCCCoooolllloooorrrr(((())))
  1374.  
  1375.           void setBorderColor(float red, float green, float blue)
  1376.  
  1377.  
  1378.  
  1379.  
  1380.  
  1381.  
  1382.                                                                        PPPPaaaaggggeeee 22221111
  1383.  
  1384.  
  1385.  
  1386.  
  1387.  
  1388.  
  1389. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1390.  
  1391.  
  1392.  
  1393.           Sets the border color to _r_e_d, _g_r_e_e_n and _b_l_u_e on all views in the
  1394.           stack. The values are assumed to be normalized to the range 0.0 to
  1395.           1.0.  See also iiiillllVVVViiiieeeewwww.
  1396.  
  1397.      sssseeeettttBBBBoooorrrrddddeeeerrrrSSSSttttyyyylllleeee(((())))
  1398.  
  1399.           void setBorderStyle(int style = ilViewBdrSolidLines)
  1400.  
  1401.  
  1402.           Sets the border style on all views, to that specified by _s_t_y_l_e. By
  1403.           default, view borders are set to iiiillllVVVViiiieeeewwwwBBBBddddrrrrSSSSoooolllliiiiddddLLLLiiiinnnneeeessss.  See iiiillllVVVViiiieeeewwww
  1404.           for more information.
  1405.  
  1406.      sssseeeettttBBBBoooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh(((())))
  1407.  
  1408.           void setBorderWidth(int width)
  1409.  
  1410.  
  1411.           Sets the border width to _w_i_d_t_h on all views in the stack.
  1412.  
  1413.      sssseeeettttBBBBoooorrrrddddeeeerrrrssss(((())))
  1414.  
  1415.           void setBorders(int enable, int mode = ilDefault)
  1416.  
  1417.  
  1418.           Sets the border flag on all views in the stack to the specified
  1419.           value.  If _f_l_a_g is TRUE, then borders are turned on, otherwise
  1420.           borders are turned off. Borders will be painted or erased unless
  1421.           defer mode has been set.
  1422.  
  1423.      sssseeeettttCCCCaaaallllllllbbbbaaaacccckkkk(((())))
  1424.  
  1425.           void setCallback(ilCallback* prepare, ilCallback* render,
  1426.                            ilCallback* finish = NULL)
  1427.  
  1428.  
  1429.           Sets the post-render callback which is associated with the back
  1430.           view.  The callback is called after all views have been rendered.
  1431.           There are actually three callbacks: _p_r_e_p_a_r_e, _r_e_n_d_e_r and _f_i_n_i_s_h.  The
  1432.           prepare callback is called by one of the compute threads to perform
  1433.           any pre-rendering allocations or computations. Then the render
  1434.           callback is called by the IL's render thread to perform actual
  1435.           rendering into the display window. This callback must execute as
  1436.           efficiently as possible to achieve maximum performance. It is called
  1437.           by the IL's render thread to minimize context switching. Any state
  1438.           changes made by the callback must be restored prior to completion.
  1439.           Finally, the finish callback is called by one of the compute threads
  1440.           to perform any de-allocation or cleanup required. The prepare and
  1441.           finish callbacks may be set to NULL if not required. See iiiillllVVVViiiieeeewwww and
  1442.           iiiillllVVVViiiieeeewwwwCCCCaaaallllllllbbbbaaaacccckkkk for more information.
  1443.  
  1444.  
  1445.  
  1446.  
  1447.  
  1448.                                                                        PPPPaaaaggggeeee 22222222
  1449.  
  1450.  
  1451.  
  1452.  
  1453.  
  1454.  
  1455. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1456.  
  1457.  
  1458.  
  1459.      sssseeeettttCCCCoooolllloooorrrrmmmmaaaapppp(((())))
  1460.  
  1461.           void setColormap(iflColormap& cmap)
  1462.  
  1463.  
  1464.           Sets the colormap to the ilLut specified by _c_m_a_p. The colormap is
  1465.           used by iiiillllXXXXDDDDiiiissssppppllllaaaayyyyIIIImmmmgggg or iiiillllGGGGLLLLDDDDiiiissssppppllllaaaayyyyIIIImmmmgggg depending on the render
  1466.           mode. Note that this will override the iiiillllDDDDeeeeffffaaaauuuullllttttCCCCmmmmaaaapppp mode passed to
  1467.           the constructor.
  1468.  
  1469.      sssseeeettttDDDDeeeeffffeeeerrrr(((())))
  1470.  
  1471.           void setDefer(int def, ilView* view = NULL)
  1472.  
  1473.  
  1474.           Sets the state of the defer flag on the specified view. If _v_i_e_w is
  1475.           NULL, then the defer flag on ilDisplay is set. If _d_e_f_e_r is TRUE,
  1476.           then painting does not occur or is deferred. When painting is
  1477.           deferred, changes to a view's position, size or image position are
  1478.           accumulated until the view can be painted. Note that ilDisplay can
  1479.           be deferred or each individual ilView can be deferred.
  1480.  
  1481.      sssseeeettttLLLLoooocccc(((())))
  1482.  
  1483.           ilView* setLoc(float ix, float iy, float x, float y,
  1484.                          int mode = ilLocIn)
  1485.  
  1486.  
  1487.           This function finds the view at xy and sets the location in the
  1488.           image specified by _i_x and _i_y to the location in the display
  1489.           specified by _x and _y. The image is moved as needed to relocate the
  1490.           specified point. If iiiillllLLLLooooccccIIIInnnn is passed in _m_o_d_e, the location is found
  1491.           in the input space of the image.  If iiiillllLLLLooooccccIIIInnnn is passed in _m_o_d_e, the
  1492.           location is found in the output space of the image.  For example, if
  1493.           an ilRotZoomIng is mapped to the view and ilLocIn is specified, _i_x
  1494.           and _i_y correspond to the location in the unrotated image. However,
  1495.           if ilLocOut is specified, _i_x and _i_y correspond to the location in
  1496.           the rotated image. The relocation can be accomplished by moving
  1497.           either the image or the view. If iiiillllLLLLooooccccVVVViiiieeeewwww is specified then the
  1498.           view is moved, alternatively if iiiillllLLLLooooccccIIIImmmmgggg is specified (default) then
  1499.           the image is moved.
  1500.  
  1501.      sssseeeettttMMMMaaaarrrrggggiiiinnnn(((())))
  1502.  
  1503.           void setMargin(int margin)
  1504.  
  1505.  
  1506.           Sets the default margin to the number of pixels specified in _m_a_r_g_i_n.
  1507.           This margin is used by ffffiiiinnnnddddEEEEddddggggeeee() if no margin is specified.
  1508.  
  1509.  
  1510.  
  1511.  
  1512.  
  1513.  
  1514.                                                                        PPPPaaaaggggeeee 22223333
  1515.  
  1516.  
  1517.  
  1518.  
  1519.  
  1520.  
  1521. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1522.  
  1523.  
  1524.  
  1525.      sssseeeettttMMMMooooddddeeee(((())))
  1526.  
  1527.           void setMode(int mode = 0)
  1528.  
  1529.  
  1530.           Sets the display mode as specified by _m_o_d_e. This display mode is
  1531.           added to the mode used to create new views with aaaaddddddddVVVViiiieeeewwww().  For
  1532.           example, if ilDefer is set in the display mode, then ilDefer will be
  1533.           added to the mode passed to addView().
  1534.  
  1535.      sssseeeettttMMMMoooouuuusssseeee(((())))
  1536.  
  1537.           void setMouse(int x, int y, int mode = 0)
  1538.  
  1539.  
  1540.           Sets the starting mouse location to the coordinate _x, _y.  Note that
  1541.           x and y are interpreted in the current event space, which is
  1542.           determined by the type of window (X or GL) being used.  This method
  1543.           is typically used to preset mouse values to initialize an
  1544.           interactive display operation loop such as moving a view.
  1545.  
  1546.      sssseeeettttNNNNoooopppp(((())))
  1547.  
  1548.           void setNop(int noOp, ilView* view = NULL)
  1549.  
  1550.  
  1551.           Sets NOP state for the specified view. If view is NULL, then all
  1552.           views are set. If set to TRUE, display operations are disabled on
  1553.           this view until the flag is set to FALSE.
  1554.  
  1555.      sssseeeettttPPPPiiiixxxxeeeellll(((())))
  1556.  
  1557.           ilView* setPixel(int x, int y, iflPixel& pix)
  1558.  
  1559.  
  1560.           Sets the pixel located _x and _y to the value specified in _p_i_x.  First
  1561.           the view at _x,_y is found using ffffiiiinnnnddddVVVViiiieeeewwww() and sssseeeettttPPPPiiiixxxxeeeellll() is called
  1562.           on that ilView. See the ilView man page for more information.
  1563.  
  1564.      sssseeeettttRRRRooooaaaammmmLLLLiiiimmmmiiiitttt(((())))
  1565.  
  1566.           void setRoamLimit(float maxRoamDel = 0.0)
  1567.  
  1568.  
  1569.           Sets the maximum number of pixels an image can move.  The roam limit
  1570.           causes image movement to be limited in order to facilitate smooth
  1571.           roaming with mmmmoooovvvveeeeIIIImmmmgggg(). The roam limit is used to calculate the
  1572.           maximum roam rate in x and y for a given direction. If _m_a_x_R_o_a_m_D_e_l is
  1573.           set to 0.0 or negative, the roam limit is disabled.
  1574.  
  1575.  
  1576.  
  1577.  
  1578.  
  1579.  
  1580.                                                                        PPPPaaaaggggeeee 22224444
  1581.  
  1582.  
  1583.  
  1584.  
  1585.  
  1586.  
  1587. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1588.  
  1589.  
  1590.  
  1591.      sssseeeettttSSSSttttaaaattttuuuussss(((())))
  1592.  
  1593.           void setStatus(ilStatus stat)
  1594.  
  1595.  
  1596.           Sets the status of ilDisplay to the ilStatus specified in _s_t_a_t.  See
  1597.           also ggggeeeettttSSSSttttaaaattttuuuussss().
  1598.  
  1599.      sssseeeettttVVVViiiissssiiiibbbblllleeeeAAAArrrreeeeaaaa(((())))
  1600.  
  1601.           void setVisibleArea(int x = 0, int y = 0, int nx = 0,
  1602.                               int ny = 0)
  1603.  
  1604.  
  1605.           Sets the visible area within the display window in order to
  1606.           optimally support scrolled windows. The origin of the area is
  1607.           specified as _x, _y and the size of the area is specified by _n_x, _n_y.
  1608.           This causes painting to be clipped to the visual area.  If _0 is
  1609.           passed for all area parameters then this function is disabled.
  1610.  
  1611.      sssseeeettttWWWWiiiinnnnddddoooowwww(((())))
  1612.  
  1613.           void setWindow(Window win, int mode = ilDefault)
  1614.  
  1615.  
  1616.           Sets the display window to the X window specified in _w_i_n and
  1617.           reinitializes ilDisplay. The render mode and display mode are
  1618.           specified as in the constructor. This function is used to change the
  1619.           configuration of the display window used by ilDisplay.
  1620.  
  1621.      sssspppplllliiiitttt(((())))
  1622.  
  1623.           void split(int mode = ilAbsSplit|ilRowSplit|ilColSplit)
  1624.  
  1625.  
  1626.           This function repositions and resizes all views in the view stack so
  1627.           that all views are visible. The _m_o_d_e specifies how the views are
  1628.           arranged. Starting at the bottom of the view stack, views are placed
  1629.           starting at the upper left corner of the display.  The various split
  1630.           modes are listed below:
  1631.  
  1632.           _i_l_A_b_s_S_p_l_i_t All images are aligned based on the align mode
  1633.                      specified (ilBottomLeft by default).
  1634.  
  1635.           _i_l_R_e_l_S_p_l_i_t All images are positioned relative to the view
  1636.                      position.
  1637.  
  1638.           _i_l_R_o_w_S_p_l_i_t The views are arranged in rows.
  1639.  
  1640.           _i_l_C_o_l_S_p_l_i_t The views are arranged in columns.
  1641.  
  1642.  
  1643.  
  1644.  
  1645.  
  1646.                                                                        PPPPaaaaggggeeee 22225555
  1647.  
  1648.  
  1649.  
  1650.  
  1651.  
  1652.  
  1653. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1654.  
  1655.  
  1656.  
  1657.           _i_l_P_a_c_k_S_p_l_i_t Views sizes are clipped to the size of the image and
  1658.                      packed together.
  1659.  
  1660.           The relative split mode causes images to be positioned so that the
  1661.           image continues from one view to the next.  Any combination of these
  1662.           split modes can be used. For example, if
  1663.           ilRowSplit | ilColSplit is specified in _m_o_d_e, views are arranged
  1664.           into an equal number of rows and columns.
  1665.  
  1666.      sssswwwwaaaapppp(((())))
  1667.  
  1668.           void swap(ilView* view1, ilView* view2)
  1669.  
  1670.  
  1671.           Swaps the positions in the view stack of the two views specified.
  1672.  
  1673.      ssssyyyynnnnccccPPPPaaaaiiiinnnntttt(((())))
  1674.  
  1675.           void syncPaint()
  1676.  
  1677.  
  1678.           This method will not return until all queued rendering requests are
  1679.           completed.  See eeeennnnaaaabbbblllleeeeQQQQuuuueeeeuuuueeeeiiiinnnngggg().
  1680.  
  1681.      uuuunnnnsssseeeelllleeeecccctttt(((())))
  1682.  
  1683.           void unselect(ilView* view = NULL)
  1684.  
  1685.  
  1686.           Unselects the specified view. If NULL is passed, then all views in
  1687.           the view stack are unselected (except those with nop flag set).
  1688.           When a view is unselected, its nop flag is TRUE and its borders are
  1689.           disabled.
  1690.  
  1691.      uuuuppppddddaaaatttteeee(((())))
  1692.  
  1693.           void update(int x = 0, int y = 0, int nx = 0, int ny = 0,
  1694.                       float imgX = 0, float imgY = 0, ilView* view = NULL,
  1695.                       int mode = ilDelVal)
  1696.  
  1697.  
  1698.           This function allows the view position, view size and image position
  1699.           to be adjusted for the specified view. If no view is specified, then
  1700.           all views are updated. The view is moved as specified by _x and _y.
  1701.           The view size is adjusted as specified by _n_x and _n_y. The image is
  1702.           moved within the view as specified by _i_m_g_X and _i_m_g_Y. All three
  1703.           adjustments are clipped if ilClip is passed in _m_o_d_e. After all three
  1704.           adjustments are made the view is painted, unless ilDefer is passed
  1705.           in _m_o_d_e.
  1706.  
  1707.  
  1708.  
  1709.  
  1710.  
  1711.  
  1712.                                                                        PPPPaaaaggggeeee 22226666
  1713.  
  1714.  
  1715.  
  1716.  
  1717.  
  1718.  
  1719. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1720.  
  1721.  
  1722.  
  1723.           If ilDelVal is passed in _m_o_d_e, all parameters specify the change
  1724.           (delta) in position and size. If ilAbsVal is specified, all
  1725.           parameters specify the absolute position or size. If ilRelVal is
  1726.           passed in _m_o_d_e, then all parameters are interpreted relative to a
  1727.           starting xy coordinate maintained within ilDisplay. ilRelVal is not
  1728.           recommended for use with this operator. See moveView and moveImg for
  1729.           more details.
  1730.  
  1731.      uuuuppppddddaaaatttteeeeWWWWiiiinnnnddddoooowwww(((())))
  1732.  
  1733.           void updateWindow()
  1734.  
  1735.  
  1736.           This function is used to reinitialize the ilDisplay when the
  1737.           configuration of the display window has been changed. For example,
  1738.           if the GL window is changed from RGB mode to color index,
  1739.           uuuuppppddddaaaatttteeeeWWWWiiiinnnnddddoooowwww() must be called.
  1740.  
  1741.      wwwwiiiippppeeee(((())))
  1742.  
  1743.           void wipe(int x, int y, ilView* view = NULL, int mode = ilRelVal)
  1744.  
  1745.  
  1746.           This function moves one or more edges on the specified view. If NULL
  1747.           is passed, then all views are wiped (except those with nop flag
  1748.           set). The edge or edges to move are specified in _m_o_d_e. For example,
  1749.           if ilRightEdge is passed in mode, the right edge of the view moves
  1750.           as specified by _x and _y. In addition, if ilTopEdge | ilRightEdge (or
  1751.           ilTopRight) is specified, then the upper right corner is moved. Note
  1752.           that the value returned by ffffiiiinnnnddddEEEEddddggggeeee() can be used directly.
  1753.  
  1754.           In general, a wipe operation resizes the view. However, if ilAllEdge
  1755.           is passed in mode, then all edges of the view are moved and the view
  1756.           size is unchanged.  This operation is referred to as an _i_n_s_e_t - the
  1757.           image is stationary and the view moves. This is the opposite of
  1758.           moving the image within the view. When comparing images, wiping is
  1759.           very useful.
  1760.  
  1761.           If ilDelVal is passed in _m_o_d_e, _x and _y specify the change (delta) in
  1762.           the image position. If ilAbsVal is specified, _x and _y specify the
  1763.           new position of the image. If ilRelVal is passed in _m_o_d_e, then _x and
  1764.           _y are interpreted relative to a starting _x_y coordinate maintained
  1765.           within ilDisplay.
  1766.  
  1767.           If ilClip is passed in _m_o_d_e, the the edge is not allowed to move
  1768.           beyond the edge of the image. However, by default the edge can be
  1769.           moved beyond the edge of the image, exposing the image's fill value.
  1770.           If ilDefer is passed in _m_o_d_e, then the view is not painted after the
  1771.           operation.
  1772.  
  1773.  
  1774.  
  1775.  
  1776.  
  1777.  
  1778.                                                                        PPPPaaaaggggeeee 22227777
  1779.  
  1780.  
  1781.  
  1782.  
  1783.  
  1784.  
  1785. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1786.  
  1787.  
  1788.  
  1789.      wwwwiiiippppeeeeSSSSiiiizzzzeeee(((())))
  1790.  
  1791.           void wipeSize(int x, int y, ilView* view = NULL,
  1792.                         int mode = ilDelVal|ilTopRight)
  1793.  
  1794.  
  1795.           This function moves an edge or corner and the opposite edge or
  1796.           corner on the specified view. If NULL is passed, then all views in
  1797.           the view stack are affected (except those with nop flag set).  The
  1798.           edge or corner passed in _m_o_d_e is moved as specified by _x and _y. In
  1799.           addition, the opposite edge or corner is moved in the opposite
  1800.           direction. This causes the view to grow or shrink by moving opposite
  1801.           edges or corners. For example, if the right edge is moved right by
  1802.           ten pixels, the left edge is also moved left by ten pixels. Note
  1803.           that the value returned by ffffiiiinnnnddddEEEEddddggggeeee(((()))) can be used directly.
  1804.  
  1805.           If ilDelVal is passed in _m_o_d_e, _x and _y specify the change (delta) in
  1806.           the image position. If ilAbsVal is specified, _x and _y specify the
  1807.           new position of the image. If ilRelVal is passed in _m_o_d_e, then _x and
  1808.           _y are interpreted relative to a starting _x_y coordinate maintained
  1809.           within ilDisplay.
  1810.  
  1811.      wwwwiiiippppeeeeSSSSpppplllliiiitttt(((())))
  1812.  
  1813.           void wipeSplit(int x, int y, int mode = ilRelVal)
  1814.  
  1815.  
  1816.           This function moves the edge on all views, found by calling
  1817.           ffffiiiinnnnddddEEEEddddggggeeee(((()))) on ilDisplay. All of these edges are moved as specified
  1818.           by _x and _y. For example, if two views are displayed side-by-side,
  1819.           the right edge of the left view and the left edge of the right view
  1820.           can be moved simultaneously. This is useful after a split operation.
  1821.  
  1822.           If ilDelVal is passed in _m_o_d_e, _x and _y specify the change (delta) in
  1823.           the image position. If ilAbsVal is specified, _x and _y specify the
  1824.           new position of the image. If ilRelVal is passed in _m_o_d_e, then _x and
  1825.           _y are interpreted relative to a starting _x_y coordinate maintained
  1826.           within ilDisplay.
  1827.  
  1828. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  1829.      ilXWindowImg, ilView, ilViewIter, <il/ilDisplayDefs.h>
  1830.  
  1831.  
  1832. NNNNOOOOTTTTEEEESSSS
  1833.      Many display operators take a _m_o_d_e parameter which is a bit-wise
  1834.      inclusive OR of various flags defined in ilDisplayDefs.h. These flags are
  1835.      interpreted based on which operator is called. For example, iiiillllCCCCeeeennnntttteeeerrrr can
  1836.      be used to align a view or can be used to locate  the center of a view.
  1837.  
  1838.      All views in the view stack are deleted when ilDisplay is deleted.
  1839.  
  1840.  
  1841.  
  1842.  
  1843.  
  1844.                                                                        PPPPaaaaggggeeee 22228888
  1845.  
  1846.  
  1847.  
  1848.  
  1849.  
  1850.  
  1851. iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllDDDDiiiissssppppllllaaaayyyy((((3333))))
  1852.  
  1853.  
  1854.  
  1855.      ilViewIter can be used to iterate through the view stack. It is declared
  1856.      in _i_l_D_i_s_p_l_a_y._h
  1857.  
  1858.  
  1859.  
  1860.  
  1861.  
  1862.  
  1863.  
  1864.  
  1865.  
  1866.  
  1867.  
  1868.  
  1869.  
  1870.  
  1871.  
  1872.  
  1873.  
  1874.  
  1875.  
  1876.  
  1877.  
  1878.  
  1879.  
  1880.  
  1881.  
  1882.  
  1883.  
  1884.  
  1885.  
  1886.  
  1887.  
  1888.  
  1889.  
  1890.  
  1891.  
  1892.  
  1893.  
  1894.  
  1895.  
  1896.  
  1897.  
  1898.  
  1899.  
  1900.  
  1901.  
  1902.  
  1903.  
  1904.  
  1905.  
  1906.  
  1907.  
  1908.  
  1909.  
  1910.                                                                        PPPPaaaaggggeeee 22229999
  1911.  
  1912.  
  1913.  
  1914.